<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GtkPixmap</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="GTK+ 2 Reference Manual">
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
<link rel="prev" href="GtkOptionMenu.html" title="GtkOptionMenu">
<link rel="next" href="GtkPreview.html" title="GtkPreview">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GtkOptionMenu.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="DeprecatedObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GTK+ 2 Reference Manual</th>
<td><a accesskey="n" href="GtkPreview.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GtkPixmap.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#GtkPixmap.description" class="shortcut">Description</a>
                   | 
                  <a href="#GtkPixmap.object-hierarchy" class="shortcut">Object Hierarchy</a>
                   | 
                  <a href="#GtkPixmap.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</td></tr>
</table>
<div class="refentry">
<a name="GtkPixmap"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GtkPixmap.top_of_page"></a>GtkPixmap</span></h2>
<p>GtkPixmap — A widget displaying a graphical image or icon</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GtkPixmap.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;gtk/gtk.h&gt;

struct              <a class="link" href="GtkPixmap.html#GtkPixmap-struct" title="struct GtkPixmap">GtkPixmap</a>;
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         <a class="link" href="GtkPixmap.html#gtk-pixmap-new" title="gtk_pixmap_new ()">gtk_pixmap_new</a>                      (<em class="parameter"><code><a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> *pixmap</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> *mask</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GtkPixmap.html#gtk-pixmap-set" title="gtk_pixmap_set ()">gtk_pixmap_set</a>                      (<em class="parameter"><code><a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> *pixmap</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> *val</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> *mask</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GtkPixmap.html#gtk-pixmap-get" title="gtk_pixmap_get ()">gtk_pixmap_get</a>                      (<em class="parameter"><code><a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> *pixmap</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> **val</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> **mask</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="GtkPixmap.html#gtk-pixmap-set-build-insensitive" title="gtk_pixmap_set_build_insensitive ()">gtk_pixmap_set_build_insensitive</a>    (<em class="parameter"><code><a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> *pixmap</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> build</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GtkPixmap.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
               +----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
                     +----<a class="link" href="GtkMisc.html" title="GtkMisc">GtkMisc</a>
                           +----GtkPixmap
</pre>
</div>
<div class="refsect1">
<a name="GtkPixmap.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GtkPixmap implements
 AtkImplementorIface and  <a class="link" href="GtkBuildable.html" title="GtkBuildable">GtkBuildable</a>.</p>
</div>
<div class="refsect1">
<a name="GtkPixmap.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> widget displays a graphical image or icon.
The icon is typically created using <a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#gdk-pixmap-colormap-create-from-xpm"><code class="function">gdk_pixmap_colormap_create_from_xpm()</code></a>
or <a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#gdk-pixmap-colormap-create-from-xpm-d"><code class="function">gdk_pixmap_colormap_create_from_xpm_d()</code></a>.
</p>
<p>
The pixels in a <a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> cannot be manipulated by the application after
creation, since under the X Window system the pixel data is stored on the
X server and so is not available to the client application.
If you want to create graphical images which can be manipulated by the
application, look at <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> and <span class="type">GdkRGB</span>.
</p>
<p>
GtkPixmap has been deprecated since GTK+ 2.0 and should not be used
in newly written code. Use <a class="link" href="GtkImage.html" title="GtkImage"><span class="type">GtkImage</span></a> instead.
</p>
</div>
<div class="refsect1">
<a name="GtkPixmap.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GtkPixmap-struct"></a><h3>struct GtkPixmap</h3>
<pre class="programlisting">struct GtkPixmap;</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">GtkPixmap</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
The <a class="link" href="GtkPixmap.html#GtkPixmap-struct" title="struct GtkPixmap"><span class="type">GtkPixmap</span></a> struct contains private data only, and
should be accessed using the functions below.
</p>
</div>
<hr>
<div class="refsect2">
<a name="gtk-pixmap-new"></a><h3>gtk_pixmap_new ()</h3>
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> *         gtk_pixmap_new                      (<em class="parameter"><code><a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> *pixmap</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> *mask</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_pixmap_new</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Creates a new <a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a>, using the given GDK pixmap and mask.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixmap</code></em> :</span></p></td>
<td>a <span class="type">GDKPixmap</span>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
<td>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a new <a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-pixmap-set"></a><h3>gtk_pixmap_set ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_pixmap_set                      (<em class="parameter"><code><a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> *pixmap</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> *val</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> *mask</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_pixmap_set</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Sets the <a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> and <a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> mask.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixmap</code></em> :</span></p></td>
<td>a <a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
<td>a <a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
<td>a <a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a>, which indicates which parts of the <em class="parameter"><code>pixmap</code></em> should be
transparent. This can be NULL, in which case none of the <em class="parameter"><code>pixmap</code></em> is
transparent.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-pixmap-get"></a><h3>gtk_pixmap_get ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_pixmap_get                      (<em class="parameter"><code><a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> *pixmap</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> **val</code></em>,
                                                         <em class="parameter"><code><a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> **mask</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_pixmap_get</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Gets the current <a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> and <a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> mask.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixmap</code></em> :</span></p></td>
<td>a <a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
<td>returns the current <a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
<td>returns the current <a href="../gdk/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> mask.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gtk-pixmap-set-build-insensitive"></a><h3>gtk_pixmap_set_build_insensitive ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                gtk_pixmap_set_build_insensitive    (<em class="parameter"><code><a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> *pixmap</code></em>,
                                                         <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> build</code></em>);</pre>
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
<h3 class="title">Warning</h3>
<p><code class="literal">gtk_pixmap_set_build_insensitive</code> is deprecated and should not be used in newly-written code.</p>
</div>
<p>
Sets wether an extra pixmap should be automatically created and used
when the pixmap is insensitive. The default value is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>pixmap</code></em> :</span></p></td>
<td>a <a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a>.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>build</code></em> :</span></p></td>
<td>set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if an extra pixmap should be automatically created to use
when the pixmap is insensitive.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>